Merging to release-5.3.0: [TT-11371] Move leaky-bucket behind the dev build flag (5.3.0) (#6073) #6076

buger · 2024-02-27T04:07:05Z

User description

TT-11371 Move leaky-bucket behind the dev build flag (5.3.0) (#6073)

User description

https://tyktech.atlassian.net/browse/TT-11371

Type

enhancement, configuration changes

Description

Moved the Leaky Bucket rate limiter configuration behind a development
build flag.
Removed the Leaky Bucket rate limiter option from the main
configuration, making it exclusive to development builds.
Updated tests and internal logic to reflect the removal of the Leaky
Bucket rate limiter from the main configuration.
Adjusted CLI linter schema to remove references to the now
development-only Leaky Bucket rate limiter.

Changes walkthrough

Relevant files

Enhancement

development.go `Add Leaky Bucket Rate Limiter to Development Config` config/development.go Added `EnableLeakyBucketRateLimiter` configuration option to `DevelopmentConfig`.	+9/-0

Configuration changes

rate_limit.go `Remove Leaky Bucket Rate Limiter from Main Config` config/rate_limit.go Removed `EnableLeakyBucketRateLimiter` from `RateLimit` struct. Adjusted string representation logic for rate limiters.	+0/-13
rate_nodev.go `Adjust Rate Limiter Handling for Release Builds` internal/rate/rate_nodev.go Removed Leaky Bucket rate limiter handling for release builds.	+0/-3
schema.json `Update CLI Linter Schema` cli/linter/schema.json Removed JSON schema entries related to Leaky Bucket rate limiter.	+0/-9

Tests

mw_rate_limiting_test.go `Update Rate Limiting Middleware Tests` gateway/mw_rate_limiting_test.go Removed test case setup for Leaky Bucket rate limiter.	+0/-2

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools
and their descriptions

Co-authored-by: Tit Petric [email protected]

Type

enhancement, configuration changes

Description

Moved the Leaky Bucket rate limiter configuration behind a development build flag, making it exclusive to development builds.
Removed the Leaky Bucket rate limiter option from the main configuration.
Updated tests and internal logic to reflect the removal of the Leaky Bucket rate limiter from the main configuration.
Adjusted CLI linter schema to remove references to the now development-only Leaky Bucket rate limiter.

Changes walkthrough

Relevant files

Enhancement

development.go `Add Leaky Bucket Rate Limiter to Development Config` config/development.go Added `EnableLeakyBucketRateLimiter` configuration option to `DevelopmentConfig`.	+9/-0
rate_nodev.go `Adjust Rate Limiter Kind Check for Release Builds` internal/rate/rate_nodev.go Removed Leaky Bucket rate limiter check from `LimiterKind` function.	+0/-3

Configuration changes

rate_limit.go `Remove Leaky Bucket Rate Limiter from Main Config` config/rate_limit.go Removed `EnableLeakyBucketRateLimiter` from `RateLimit` struct.	+0/-13
schema.json `Update CLI Linter Schema to Reflect Configuration Changes` cli/linter/schema.json Removed JSON schema entries related to the Leaky Bucket rate limiter.	+0/-9

Tests

mw_rate_limiting_test.go `Update Rate Limiting Middleware Tests` gateway/mw_rate_limiting_test.go Removed test cases for Leaky Bucket rate limiter.	+0/-6

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

## **User description** https://tyktech.atlassian.net/browse/TT-11371 ___ ## **Type** enhancement, configuration changes ___ ## **Description** - Moved the Leaky Bucket rate limiter configuration behind a development build flag. - Removed the Leaky Bucket rate limiter option from the main configuration, making it exclusive to development builds. - Updated tests and internal logic to reflect the removal of the Leaky Bucket rate limiter from the main configuration. - Adjusted CLI linter schema to remove references to the now development-only Leaky Bucket rate limiter. ___ ## **Changes walkthrough** <table><thead><tr><th></th><th align="left">Relevant files</th></tr></thead><tbody><tr><td><strong>Enhancement</strong></td><td><table> <tr> <td> <details> <summary><strong>development.go</strong><dd><code>Add Leaky Bucket Rate Limiter to Development Config</code>            </dd></summary> <hr> config/development.go <li>Added <code>EnableLeakyBucketRateLimiter</code> configuration option to <br><code>DevelopmentConfig</code>.<br> </details> </td> <td><a href="https://pull/6073/files#diff-d2253d9377e5163d9de068a2df71738383fb97e0b07b64482404a83610cd53b8">+9/-0</a>      </td> </tr> </table></td></tr><tr><td><strong>Configuration changes</strong></td><td><table> <tr> <td> <details> <summary><strong>rate_limit.go</strong><dd><code>Remove Leaky Bucket Rate Limiter from Main Config</code>                </dd></summary> <hr> config/rate_limit.go <li>Removed <code>EnableLeakyBucketRateLimiter</code> from <code>RateLimit</code> struct.<br> <li> Adjusted string representation logic for rate limiters.<br> </details> </td> <td><a href="https://pull/6073/files#diff-375bf116f8d6527c50d7591d7cb01e8f821b22df4a4ca18b4da4c6f0d526f18e">+0/-13</a>    </td> </tr> <tr> <td> <details> <summary><strong>rate_nodev.go</strong><dd><code>Adjust Rate Limiter Handling for Release Builds</code>                    </dd></summary> <hr> internal/rate/rate_nodev.go - Removed Leaky Bucket rate limiter handling for release builds. </details> </td> <td><a href="https://pull/6073/files#diff-5c08f4f86a19b6cc3d2ee94a0253749acc927b606b1c56d6b73aee46547cf4f7">+0/-3</a>      </td> </tr> <tr> <td> <details> <summary><strong>schema.json</strong><dd><code>Update CLI Linter Schema</code>                                                                  </dd></summary> <hr> cli/linter/schema.json - Removed JSON schema entries related to Leaky Bucket rate limiter. </details> </td> <td><a href="https://pull/6073/files#diff-103cec746d3e61d391c5a67c171963f66fea65d651d704d5540e60aa5d574f46">+0/-9</a>      </td> </tr> </table></td></tr><tr><td><strong>Tests</strong></td><td><table> <tr> <td> <details> <summary><strong>mw_rate_limiting_test.go</strong><dd><code>Update Rate Limiting Middleware Tests</code>                                        </dd></summary> <hr> gateway/mw_rate_limiting_test.go - Removed test case setup for Leaky Bucket rate limiter. </details> </td> <td><a href="https://pull/6073/files#diff-7cf2199231924147d538ba7ad576a48a3c0e691852077e147c9b2d86ba9b7c4d">+0/-2</a>      </td> </tr> </table></td></tr></tr></tbody></table> ___ > ✨ **PR-Agent usage**: >Comment `/help` on the PR to get a list of all available PR-Agent tools and their descriptions --------- Co-authored-by: Tit Petric <[email protected]> (cherry picked from commit 485ebf8)

github-actions · 2024-02-27T04:07:58Z

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

github-actions · 2024-02-27T04:08:01Z

💥 CI tests failed 🙈

git-state

all ok

Please look at the run or in the Checks tab.

github-actions · 2024-02-27T04:08:03Z

PR Description updated to latest commit (b168823)

github-actions · 2024-02-27T04:08:34Z

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and localized to specific configuration and test files. The logic is not complex, but careful attention should be paid to ensure that the feature flagging is correctly implemented and that no unintended side effects occur due to the removal of the Leaky Bucket rate limiter from the main configuration.
🧪 Relevant tests	Yes
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

relevant file	config/development.go
suggestion	Consider adding validation logic for `EnableLeakyBucketRateLimiter` in the development configuration to ensure it's not enabled in production environments by mistake. This could be implemented as a startup check or a compile-time assertion. [important]
relevant line	EnableLeakyBucketRateLimiter bool `json:"enable_leaky_bucket_rate_limiter"`

relevant file	gateway/mw_rate_limiting_test.go
suggestion	Since the Leaky Bucket rate limiter tests have been removed, ensure that equivalent tests are added under a development build tag to maintain coverage for this feature when it's enabled. [important]
relevant line	-func TestMwRateLimiting_CustomRatelimitKeyEnableLeakyBucketRateLimiter(t *testing.T) {

relevant file	internal/rate/rate_nodev.go
suggestion	Ensure that there's a counterpart implementation for `LimiterKind` in a file with a development build tag that correctly handles the `EnableLeakyBucketRateLimiter` configuration to maintain functionality consistency across builds. [important]
relevant line	- if c.EnableLeakyBucketRateLimiter {

relevant file	cli/linter/schema.json
suggestion	Verify that the CLI linter schema for development builds includes the `enable_leaky_bucket_rate_limiter` field to ensure configuration files are correctly validated during development. [medium]
relevant line	- "enable_leaky_bucket_rate_limiter": {

✨ Review tool usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: `[pr_reviewer] # /review # extra_instructions=""" In the 'possible issues' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation When you first install PR-Agent app, the default mode for the `review` tool is: `pr_commands = ["/review", ...]` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels The `review` tool can auto-generate two specific types of labels for a PR: a `possible security issue` label, that detects possible security issues (`enable_review_labels_security` flag) a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Extra sub-tools The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more.
Auto-approve PRs By invoking: `/review auto_approve` The tool will automatically approve the PR, and add a comment with the approval. To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following: `[pr_reviewer] enable_auto_approval = true` (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository) You can also enable auto-approval only if the PR meets certain requirements, such as that the `estimated_review_effort` is equal or below a certain threshold, by adjusting the flag: `[pr_reviewer] maximal_review_effort = 5`
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

github-actions · 2024-02-27T04:08:36Z

PR Code Suggestions

Suggestions

enhancement

Add a default value for the `EnableLeakyBucketRateLimiter` field. Consider adding a default value for `EnableLeakyBucketRateLimiter` in the `DevelopmentConfig` struct to explicitly define the default behavior. This can improve readability and make the default behavior clear. config/development.go [15] -EnableLeakyBucketRateLimiter bool `json:"enable_leaky_bucket_rate_limiter"` +EnableLeakyBucketRateLimiter bool `json:"enable_leaky_bucket_rate_limiter" default:"false"`

maintainability

Clean up any `LeakyBucket` specific test setup or utility functions. Since the `LeakyBucket` rate limiter test case has been removed, ensure that any associated setup, teardown, or utility functions specifically designed for the `LeakyBucket` tests are also cleaned up if they are no longer needed. This helps in maintaining the cleanliness and relevance of the test code. gateway/mw_rate_limiting_test.go [244-245] -default: - t.Fatal("There is no such a rate limiter:", limiter) +// Ensure any LeakyBucket specific setup/teardown functions are also removed if not needed.
Update or remove production code checks for `LeakyBucket` rate limiter. Given that the `EnableLeakyBucketRateLimiter` configuration has been moved, ensure that any logic or checks related to the `LeakyBucket` rate limiter in production code (not just development or test code) are also appropriately updated or removed. This ensures consistency and prevents potential dead code or incorrect behavior in production. internal/rate/rate_nodev.go [13-14] -return "", false +// Ensure production code is also updated to reflect the removal of EnableLeakyBucketRateLimiter checks.
Update schema references and conditions related to `LeakyBucket` rate limiter. After removing the `enable_leaky_bucket_rate_limiter` configuration, review the schema to ensure that any references or dependencies, such as those in conditional schemas or descriptions that mention the `LeakyBucket` rate limiter, are also updated. This keeps the schema accurate and prevents confusion. cli/linter/schema.json [409-410] -"enable_non_transactional_rate_limiter": { - "type": "boolean" -} +// Review and update schema descriptions or conditions that may reference the removed LeakyBucket rate limiter.

documentation

Update documentation related to `LeakyBucket` rate limiter configuration. After moving the `EnableLeakyBucketRateLimiter` configuration, ensure that the documentation and comments in related configuration structures or interfaces are updated to reflect the new location or to remove references to the `LeakyBucket` if it's no longer applicable. This helps in keeping the documentation accurate and relevant. config/rate_limit.go [11] -EnableRedisRollingLimiter bool `json:"enable_redis_rolling_limiter"` +// Update documentation to reflect the move of EnableLeakyBucketRateLimiter or its removal.

✨ Improve tool usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: `pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: `[pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

buger · 2024-02-27T04:37:56Z

API tests result - postgres15-murmur64 env: success ✅
Branch used: refs/heads/release-5.3.0
Commit: 09ade6b Merging to release-5.3.0: TT-11371 Move leaky-bucket behind the dev build flag (5.3.0) (#6073)

TT-11371 Move leaky-bucket behind the dev build flag (5.3.0) (#6073)

User description

https://tyktech.atlassian.net/browse/TT-11371

Type

enhancement, configuration changes

Description

Moved the Leaky Bucket rate limiter configuration behind a development
build flag.
Removed the Leaky Bucket rate limiter option from the main
configuration, making it exclusive to development builds.
Updated tests and internal logic to reflect the removal of the Leaky
Bucket rate limiter from the main configuration.
Adjusted CLI linter schema to remove references to the now
development-only Leaky Bucket rate limiter.

Changes walkthrough

Relevant files

Enhancement

development.go `Add Leaky Bucket Rate Limiter to Development Config` config/development.go Added `EnableLeakyBucketRateLimiter` configuration option to `DevelopmentConfig`.	+9/-0

Configuration changes

rate_limit.go `Remove Leaky Bucket Rate Limiter from Main Config` config/rate_limit.go Removed `EnableLeakyBucketRateLimiter` from `RateLimit` struct. Adjusted string representation logic for rate limiters.	+0/-13
rate_nodev.go `Adjust Rate Limiter Handling for Release Builds` internal/rate/rate_nodev.go Removed Leaky Bucket rate limiter handling for release builds.	+0/-3
schema.json `Update CLI Linter Schema` cli/linter/schema.json Removed JSON schema entries related to Leaky Bucket rate limiter.	+0/-9

Tests

mw_rate_limiting_test.go `Update Rate Limiting Middleware Tests` gateway/mw_rate_limiting_test.go Removed test case setup for Leaky Bucket rate limiter.	+0/-2

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools
and their descriptions

Co-authored-by: Tit Petric [email protected]
Triggered by: push (@buger)
Execution page

buger · 2024-02-27T04:37:57Z

API tests result - mongo44-murmur64 env: success ✅
Branch used: refs/heads/release-5.3.0
Commit: 09ade6b Merging to release-5.3.0: TT-11371 Move leaky-bucket behind the dev build flag (5.3.0) (#6073)

TT-11371 Move leaky-bucket behind the dev build flag (5.3.0) (#6073)

User description

https://tyktech.atlassian.net/browse/TT-11371

Type

enhancement, configuration changes

Description

Moved the Leaky Bucket rate limiter configuration behind a development
build flag.
Removed the Leaky Bucket rate limiter option from the main
configuration, making it exclusive to development builds.
Updated tests and internal logic to reflect the removal of the Leaky
Bucket rate limiter from the main configuration.
Adjusted CLI linter schema to remove references to the now
development-only Leaky Bucket rate limiter.

Changes walkthrough

Relevant files

Enhancement

development.go `Add Leaky Bucket Rate Limiter to Development Config` config/development.go Added `EnableLeakyBucketRateLimiter` configuration option to `DevelopmentConfig`.	+9/-0

Configuration changes

rate_limit.go `Remove Leaky Bucket Rate Limiter from Main Config` config/rate_limit.go Removed `EnableLeakyBucketRateLimiter` from `RateLimit` struct. Adjusted string representation logic for rate limiters.	+0/-13
rate_nodev.go `Adjust Rate Limiter Handling for Release Builds` internal/rate/rate_nodev.go Removed Leaky Bucket rate limiter handling for release builds.	+0/-3
schema.json `Update CLI Linter Schema` cli/linter/schema.json Removed JSON schema entries related to Leaky Bucket rate limiter.	+0/-9

Tests

mw_rate_limiting_test.go `Update Rate Limiting Middleware Tests` gateway/mw_rate_limiting_test.go Removed test case setup for Leaky Bucket rate limiter.	+0/-2

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools
and their descriptions

Co-authored-by: Tit Petric [email protected]
Triggered by: push (@buger)
Execution page

buger · 2024-02-27T04:38:36Z

API tests result - postgres15-sha256 env: success ✅
Branch used: refs/heads/release-5.3.0
Commit:
Triggered by: pull_request (@buger)
Execution page

buger · 2024-02-27T04:38:41Z

API tests result - mongo44-sha256 env: success ✅
Branch used: refs/heads/release-5.3.0
Commit:
Triggered by: pull_request (@buger)
Execution page

buger merged commit 09ade6b into release-5.3.0 Feb 27, 2024

buger deleted the merge/release-5.3.0/485ebf879abe082eb448e1d58e1d42bce19e1162 branch February 27, 2024 04:07

github-actions bot added enhancement configuration changes labels Feb 27, 2024

github-actions bot added the Review effort [1-5]: 2 label Feb 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merging to release-5.3.0: [TT-11371] Move leaky-bucket behind the dev build flag (5.3.0) (#6073) #6076

Merging to release-5.3.0: [TT-11371] Move leaky-bucket behind the dev build flag (5.3.0) (#6073) #6076

buger commented Feb 27, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Feb 27, 2024

github-actions bot commented Feb 27, 2024

github-actions bot commented Feb 27, 2024

github-actions bot commented Feb 27, 2024

github-actions bot commented Feb 27, 2024 •

edited

Loading

buger commented Feb 27, 2024 •

edited by jira bot

Loading

buger commented Feb 27, 2024 •

edited by jira bot

Loading

buger commented Feb 27, 2024 •

edited

Loading

buger commented Feb 27, 2024 •

edited

Loading

Merging to release-5.3.0: [TT-11371] Move leaky-bucket behind the dev build flag (5.3.0) (#6073) #6076

Merging to release-5.3.0: [TT-11371] Move leaky-bucket behind the dev build flag (5.3.0) (#6073) #6076

Conversation

buger commented Feb 27, 2024 • edited by github-actions bot Loading

User description

User description

Type

Description

Changes walkthrough

Type

Description

Changes walkthrough

github-actions bot commented Feb 27, 2024

💥 CI tests failed 🙈

git-state

github-actions bot commented Feb 27, 2024

💥 CI tests failed 🙈

git-state

github-actions bot commented Feb 27, 2024

github-actions bot commented Feb 27, 2024

PR Review

github-actions bot commented Feb 27, 2024 • edited Loading

PR Code Suggestions

buger commented Feb 27, 2024 • edited by jira bot Loading

User description

Type

Description

Changes walkthrough

buger commented Feb 27, 2024 • edited by jira bot Loading

User description

Type

Description

Changes walkthrough

buger commented Feb 27, 2024 • edited Loading

buger commented Feb 27, 2024 • edited Loading

buger commented Feb 27, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Feb 27, 2024 •

edited

Loading

buger commented Feb 27, 2024 •

edited by jira bot

Loading

buger commented Feb 27, 2024 •

edited by jira bot

Loading

buger commented Feb 27, 2024 •

edited

Loading

buger commented Feb 27, 2024 •

edited

Loading